<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>ESP8266_RTOS_SDK: include/espressif/airkiss.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ESP8266_RTOS_SDK
   &#160;<span id="projectnumber">v1.4.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_cf4dbf1328d2cf10d3f3933741525dc7.html">espressif</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">airkiss.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * airkiss.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *  Created on: 2015-1-26</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *      Author: peterfan</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#ifndef AIRKISS_H_</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#define AIRKISS_H_</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;</div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">void</span>* (*airkiss_memset_fn) (<span class="keywordtype">void</span>* ptr, <span class="keywordtype">int</span> value, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> num);</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">void</span>* (*airkiss_memcpy_fn) (<span class="keywordtype">void</span>* dst, <span class="keyword">const</span> <span class="keywordtype">void</span>* src, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> num);</div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="keyword">typedef</span> int (*airkiss_memcmp_fn) (<span class="keyword">const</span> <span class="keywordtype">void</span>* ptr1, <span class="keyword">const</span> <span class="keywordtype">void</span>* ptr2, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> num);</div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="keyword">typedef</span> int (*airkiss_printf_fn) (<span class="keyword">const</span> <span class="keywordtype">char</span>* format, ...);</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="structairkiss__config__t.html">   23</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;{</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;    airkiss_memset_fn memset;</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;    airkiss_memcpy_fn memcpy;</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    airkiss_memcmp_fn memcmp;</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    airkiss_printf_fn printf;</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;} <a class="code" href="structairkiss__config__t.html">airkiss_config_t</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__AirKiss__APIs.html#gad2485fae7edd33913a96ae91fd277acd">airkiss_version</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;</div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="group__AirKiss__APIs.html#gaa0ebed8b87dd27c1c1d80c316fe2e691">   69</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span></div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;{</div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691a3eec80987fe47f20344931bf4afeb4e4">   72</a></span>&#160;    <a class="code" href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691a3eec80987fe47f20344931bf4afeb4e4">AIRKISS_LAN_ERR_OVERFLOW</a> = -5,</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;</div>
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691a30641c2d4b8fee854a90861f957c5923">   75</a></span>&#160;    <a class="code" href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691a30641c2d4b8fee854a90861f957c5923">AIRKISS_LAN_ERR_CMD</a> = -4,</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691aa48241b150e73210e45c81aa9b76137f">   78</a></span>&#160;    <a class="code" href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691aa48241b150e73210e45c81aa9b76137f">AIRKISS_LAN_ERR_PAKE</a> = -3,</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;</div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691ae4043da2985abd40a90fd198fd607622">   81</a></span>&#160;    <a class="code" href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691ae4043da2985abd40a90fd198fd607622">AIRKISS_LAN_ERR_PARA</a> = -2,</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;</div>
<div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691a14bf764748a58af181c316c2e2ee5322">   84</a></span>&#160;    <a class="code" href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691a14bf764748a58af181c316c2e2ee5322">AIRKISS_LAN_ERR_PKG</a> = -1,</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;</div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691a6c669d0e28f90ea37e6aea8f9084c0d1">   87</a></span>&#160;    <a class="code" href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691a6c669d0e28f90ea37e6aea8f9084c0d1">AIRKISS_LAN_CONTINUE</a> = 0,</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;</div>
<div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691aad38be677ab42b9f59e773c456695b02">   90</a></span>&#160;    <a class="code" href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691aad38be677ab42b9f59e773c456695b02">AIRKISS_LAN_SSDP_REQ</a> = 1,</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;</div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691a5743b4699a34a902a43540149ef380fb">   93</a></span>&#160;    <a class="code" href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691a5743b4699a34a902a43540149ef380fb">AIRKISS_LAN_PAKE_READY</a> = 2</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;} <a class="code" href="group__AirKiss__APIs.html#gaa0ebed8b87dd27c1c1d80c316fe2e691">airkiss_lan_ret_t</a>;</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;</div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;</div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;{</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;    AIRKISS_LAN_SSDP_REQ_CMD = 0x1,</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;    AIRKISS_LAN_SSDP_RESP_CMD = 0x1001,</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;    AIRKISS_LAN_SSDP_NOTIFY_CMD = 0x1002</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;} airkiss_lan_cmdid_t;</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__AirKiss__APIs.html#ga7545a7e75de00da0b22c232de602e092">airkiss_lan_recv</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* body, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> length, <span class="keyword">const</span> <a class="code" href="structairkiss__config__t.html">airkiss_config_t</a>* config);</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;</div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__AirKiss__APIs.html#gab6bab3b00620928bca5e2adc0d2abd31">airkiss_lan_pack</a>(airkiss_lan_cmdid_t ak_lan_cmdid, <span class="keywordtype">void</span>* appid, <span class="keywordtype">void</span>* deviceid, <span class="keywordtype">void</span>* _datain, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> inlength, <span class="keywordtype">void</span>* _dataout, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span>* outlength, <span class="keyword">const</span> <a class="code" href="structairkiss__config__t.html">airkiss_config_t</a>* config);</div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;</div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;}</div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* AIRKISS_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="group__AirKiss__APIs_html_ggaa0ebed8b87dd27c1c1d80c316fe2e691ae4043da2985abd40a90fd198fd607622"><div class="ttname"><a href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691ae4043da2985abd40a90fd198fd607622">AIRKISS_LAN_ERR_PARA</a></div><div class="ttdef"><b>Definition:</b> airkiss.h:81</div></div>
<div class="ttc" id="group__AirKiss__APIs_html_ga7545a7e75de00da0b22c232de602e092"><div class="ttname"><a href="group__AirKiss__APIs.html#ga7545a7e75de00da0b22c232de602e092">airkiss_lan_recv</a></div><div class="ttdeci">int airkiss_lan_recv(const void *body, unsigned short length, const airkiss_config_t *config)</div><div class="ttdoc">Parse the UDP packet sent by AirKiss. </div></div>
<div class="ttc" id="group__AirKiss__APIs_html_gad2485fae7edd33913a96ae91fd277acd"><div class="ttname"><a href="group__AirKiss__APIs.html#gad2485fae7edd33913a96ae91fd277acd">airkiss_version</a></div><div class="ttdeci">const char * airkiss_version(void)</div><div class="ttdoc">Get the version information of AirKiss lib. </div></div>
<div class="ttc" id="group__AirKiss__APIs_html_ggaa0ebed8b87dd27c1c1d80c316fe2e691aad38be677ab42b9f59e773c456695b02"><div class="ttname"><a href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691aad38be677ab42b9f59e773c456695b02">AIRKISS_LAN_SSDP_REQ</a></div><div class="ttdef"><b>Definition:</b> airkiss.h:90</div></div>
<div class="ttc" id="group__AirKiss__APIs_html_ggaa0ebed8b87dd27c1c1d80c316fe2e691a6c669d0e28f90ea37e6aea8f9084c0d1"><div class="ttname"><a href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691a6c669d0e28f90ea37e6aea8f9084c0d1">AIRKISS_LAN_CONTINUE</a></div><div class="ttdef"><b>Definition:</b> airkiss.h:87</div></div>
<div class="ttc" id="group__AirKiss__APIs_html_ggaa0ebed8b87dd27c1c1d80c316fe2e691a5743b4699a34a902a43540149ef380fb"><div class="ttname"><a href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691a5743b4699a34a902a43540149ef380fb">AIRKISS_LAN_PAKE_READY</a></div><div class="ttdef"><b>Definition:</b> airkiss.h:93</div></div>
<div class="ttc" id="group__AirKiss__APIs_html_ggaa0ebed8b87dd27c1c1d80c316fe2e691a3eec80987fe47f20344931bf4afeb4e4"><div class="ttname"><a href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691a3eec80987fe47f20344931bf4afeb4e4">AIRKISS_LAN_ERR_OVERFLOW</a></div><div class="ttdef"><b>Definition:</b> airkiss.h:72</div></div>
<div class="ttc" id="group__AirKiss__APIs_html_ggaa0ebed8b87dd27c1c1d80c316fe2e691a30641c2d4b8fee854a90861f957c5923"><div class="ttname"><a href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691a30641c2d4b8fee854a90861f957c5923">AIRKISS_LAN_ERR_CMD</a></div><div class="ttdef"><b>Definition:</b> airkiss.h:75</div></div>
<div class="ttc" id="structairkiss__config__t_html"><div class="ttname"><a href="structairkiss__config__t.html">airkiss_config_t</a></div><div class="ttdef"><b>Definition:</b> airkiss.h:23</div></div>
<div class="ttc" id="group__AirKiss__APIs_html_ggaa0ebed8b87dd27c1c1d80c316fe2e691a14bf764748a58af181c316c2e2ee5322"><div class="ttname"><a href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691a14bf764748a58af181c316c2e2ee5322">AIRKISS_LAN_ERR_PKG</a></div><div class="ttdef"><b>Definition:</b> airkiss.h:84</div></div>
<div class="ttc" id="group__AirKiss__APIs_html_ggaa0ebed8b87dd27c1c1d80c316fe2e691aa48241b150e73210e45c81aa9b76137f"><div class="ttname"><a href="group__AirKiss__APIs.html#ggaa0ebed8b87dd27c1c1d80c316fe2e691aa48241b150e73210e45c81aa9b76137f">AIRKISS_LAN_ERR_PAKE</a></div><div class="ttdef"><b>Definition:</b> airkiss.h:78</div></div>
<div class="ttc" id="group__AirKiss__APIs_html_gab6bab3b00620928bca5e2adc0d2abd31"><div class="ttname"><a href="group__AirKiss__APIs.html#gab6bab3b00620928bca5e2adc0d2abd31">airkiss_lan_pack</a></div><div class="ttdeci">int airkiss_lan_pack(airkiss_lan_cmdid_t ak_lan_cmdid, void *appid, void *deviceid, void *_datain, unsigned short inlength, void *_dataout, unsigned short *outlength, const airkiss_config_t *config)</div><div class="ttdoc">Packaging the UDP packet. </div></div>
<div class="ttc" id="group__AirKiss__APIs_html_gaa0ebed8b87dd27c1c1d80c316fe2e691"><div class="ttname"><a href="group__AirKiss__APIs.html#gaa0ebed8b87dd27c1c1d80c316fe2e691">airkiss_lan_ret_t</a></div><div class="ttdeci">airkiss_lan_ret_t</div><div class="ttdef"><b>Definition:</b> airkiss.h:69</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Mar 1 2016 10:19:26 for ESP8266_RTOS_SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>
